Summary
Displays a button that makes it possible to a add a document to Content Studio favorite documents. This component was added in version 5.1.
| Category | AS Miscellaneous |
| Version | 1.0 |
| Complies with Xhtml 1.0 / 1.1 rules | Yes |
| Supported server programming languages | C# Visual Basic.NET |
| Output content type | inline |
When to use
This component is typically used in an Intranet when there is a need for the user to add a document to the list of favourite documents in Content Studio.
Programming interface
Parameters
- DocId
- Optional, a document id. Leave empty to use the current document
- UseRootDocId
- Use the root document rather than the current document. This is practical when the document is included in another document.
- DisplayText
- The text to display in the button generated
- Title
- Optional, a text to show in the title bar of a popup dialog shown after action.
- Image
- Optional, an image to display in the button.
- SuccessText
- A text to show when the operation was successful
- Attributes
- Optional, HTML attributes to add to the button.
- ClassName
- Optional, a CSS class name used to format the button.
Remarks
This component only works in authenticated mode with Microsoft Internet Explorer.